Obtains the region occupied by a tab.

OSStatus GetThemeTabRegion (
    const Rect *inRect, 
    ThemeTabStyle inStyle, 
    ThemeTabDirection inDirection, 
     ioRgn
);

inRect

A pointer to a structure of type Rect. Before calling GetThemeTabRegion, set the rectangle to the boundary of the tab, in local coordinates.

inStyle

A value of type ThemeTabStyle. Pass a constant specifying the relative position (front or non-front) and state of the tab to be examined. See “Theme Tab Style Constants” for descriptions of possible values.

inDirection

A value of type ThemeTabDirection. Pass a constant specifying the direction in which the tab is oriented. See “Theme Tab Direction Constants” for descriptions of possible values.

ioRgn

A value of type RgnHandle. On return, the region contains the actual dimensions and position of the tab, in local coordinates.

function result

A result code.

DISCUSSION

Because a tab can have a non-rectangular shape, your application should call GetThemeTabRegion to get the actual region containing the tab under the current theme, in order to perform accurate hit testing.

VERSION NOTES

This function is available with Appearance Manager 1.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)